home *** CD-ROM | disk | FTP | other *** search
/ Internet.Works 41 / Issue 41.iso / pc / PCSoftware / Infinite Interchange / Extras / WEBHTML.TXT < prev    next >
Encoding:
Text File  |  1998-04-22  |  57.5 KB  |  1,476 lines
  1. WEBMAIL HTML TEMPLATE DOCUMENTATION
  2. APRIL 15, 1998
  3.  
  4. PRELIMINARY (WRITTEN FOR DEVELOPERS BY DEVELOPERS - NOT REVIEWED BY
  5. TECHNICAL DOCUMENTATION)
  6.  
  7.  
  8. The WebMail Server bases the appearance of the user interface presented to
  9. web users on the set of HTML templates selected by the user.  Administrators
  10. can also configure which templete will be used by default, and can force the
  11. use of particular templates depending upon the web browser that a user is
  12. using.
  13.  
  14. Because the WebMail interface is template driven, it is possible to change
  15. many aspects of the user interface.
  16.  
  17. Each WebMail template is located in a subdirectory underneath of the HTML
  18. subdirectory of the WebMail program directory.  If you are interested in
  19. customizing a set of templates for use with WebMail, it is recommended that
  20. you start by modifying one of the pre-defined sets of templates that ship
  21. with WebMail.  This document is intended only to help explain some of the
  22. constructs that you will see in the supplied template files.
  23.  
  24. Each WebMail template subdirectory must consist of the following files:
  25.  
  26. Descript.ion - A short one-line text file that provides a description for
  27. the template in the pull-down box on the options screen.
  28.  
  29. Address.htm - Address book lookup screen
  30.  
  31. Attach.htm - Attachment screen
  32.  
  33. Create.htm - Create Message screen
  34.  
  35. DelFold.htm - Delete folder screen
  36.  
  37. FileMail.htm - File Message screen
  38.  
  39. Folders.htm - Select folder screen
  40.  
  41. Help.htm - On-line help
  42.  
  43. Login.htm - Login screen
  44.  
  45. Options.htm - User Options screen
  46.  
  47. ReadMail.htm - Read message screen
  48.  
  49. Search.htm - Search messages screen
  50.  
  51. Spell.htm - Spell check screen
  52.  
  53. VRecips.htm - Validate recipients screen (used only in the VIM and MAPI
  54. interfaces)
  55.  
  56. WebMail.htm - Message index/list screen
  57.  
  58. Any GIF file images used by the templates should also be contained in the
  59. template subdirectory.
  60.  
  61.  
  62. Each template contains a number of replaceable parameters and commands,
  63. allowing you to modify the appearance of the template, while the WebMail
  64. server will fill in the necessary data to complete the HTML file before
  65. sending it to the user's web browser.
  66.  
  67. Replaceable parameters and commands always start and end with "@@".  The
  68. following text describes the replaceable parameters and commands available
  69. in each of the template files.
  70.  
  71. Many templates also include POST functions to complete certain functions.
  72. In these cases, the variable names used in a template should not be changed,
  73. as the WebMail server expects to see certain variables.  Some of these
  74. variables may appear as input fields, checkboxes, selection lists, or even
  75. as hidden input fields that are used to maintain "state" information.
  76.  
  77.  
  78. *** Address.htm - Address book lookup screen ***
  79.  
  80. @@RecipsURL@@ - URL to post data to.
  81.  
  82. @@Template@@ - The name of the currently selected set of templates, which is
  83. useful for locating related GIF files for the template.  (e.g., GIF files
  84. are normally referenced in a template as /html/@@Template@@/filename.gif,
  85. rather than hard-coding the template name to provide flexibility in renaming
  86. templates)
  87.  
  88. @@UserName@@ - User login name.
  89.  
  90. @@MessageSubject@@ - The subject for the current message.
  91.  
  92. @@UrgentFlag@@ - Set to "Yes" if the message is flagged urgent, "No"
  93. otherwise.
  94.  
  95. @@ReturnReceiptFlag@@ - Set to "Yes" if the message is flagged return
  96. receipt requested, "No" otherwise.
  97.  
  98. @@AddSignatureFlag@@ - Set to "Yes" if the message is flagged add signature
  99. requested, "No" otherwise.
  100.  
  101. @@AttachmentList@@ - A comma-delimited list of attachments selected for the
  102. current message.  (This field should not be displayed, but must be
  103. associated with a hidden keyword of "AttachmentList".)
  104.  
  105. @@AttachmentNameList@@ - A comma-delimited list of attachments selected for
  106. the current message.  (Friendly, display format.)
  107.  
  108. @@MessageText@@ - Text of the current message.
  109.  
  110. @@SelectedToRecipients@@ - Comma-delimited list of currently selected "to"
  111. recipients, one per line.
  112.  
  113. @@SelectedCcRecipients@@ - Comma-delimited list of currently selected "cc"
  114. recipients, one per line.
  115.  
  116. @@SelectedBccRecipients@@ - Comma-delimited list of currently selected "bcc"
  117. recipients, one per line.
  118.  
  119. @@CurrentAddressBook@@ - Name of the currently selected address book.
  120.  
  121. @@AvailableRecipsList@@ - Repeated for each recipient in the current address
  122. book with the recipient replacing the @@ placeholder.
  123.  
  124. @@AddressBookList@@ - Repeated for each defined address book with the
  125. address book name replacing the @@ placeholder.
  126.  
  127. @@MaxRecips@@=### - Not a conventional replacement variable.  If present,
  128. WebMail will limit the number of recipients displayed in an address book
  129. window to ### recipients.  (This was done because the Mac versions of both
  130. Netscape and Internet Explorer will choke on listboxes that contain more
  131. than 32KB of data.)
  132.  
  133. @@AvailableRecipsMax@@ - Set by the server to the value specified for
  134. @@MaxRecips@@ in the original template file.
  135.  
  136. @@AvailableRecipsTop@@ - To support scrolling in an address book larger than
  137. @@MaxRecips@@, this variable specifies the current index into the available
  138. recipient list.
  139.  
  140. Special begin/end logic that allows certain lines to be included only if a
  141. particular condition is met:
  142.  
  143. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  144. automatically write carriage return/line feeds out when processing the
  145. template file.
  146.  
  147. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  148. carriage return/line feeds when processing the template file.
  149.  
  150. @@BeginIfAtTop@@ - When this keyword is encountered, any lines that follow,
  151. up to a closing @@EndIfAtTop@@ will only be included if the available
  152. recipients list is at the top.  (e.g., if the top of the list is the first
  153. recipient)
  154.  
  155. @@BeginIfNotAtTop@@ - When this keyword is encountered, any lines that
  156. follow, up to a closing @@EndIfNotAtTop@@ will only be included if the
  157. available recipient list is not at the top.  (e.g., if the top of the list
  158. is not the first recipient)
  159.  
  160. @@BeginIfAtBottom@@ - When this keyword is encountered, any lines that
  161. follow, up to a closing @@EndIfAtBottom@@ will only be included if the
  162. available recipient list is at the bottom.  (e.g., if the last recipient in
  163. the address book is displayed on the current page)
  164.  
  165. @@BeginIfNotAtBottom@@ - When this keyword is encountered, any lines that
  166. follow, up to a closing @@EndIfNotAtBottom@@ will only be included if the
  167. available recipient list is not at the bottom.  (e.g., if there are more
  168. recipients in the address book beyond the last recipient displayed on the
  169. current page)
  170.  
  171. Post variables:
  172.  
  173. DoneAddress - SUBMIT BUTTON - Returns the user to the create message
  174. screen.
  175.  
  176. SearchAddress - SUBMIT BUTTON - Performs an address book search for the
  177. value specified in the "SearchData" field.
  178.  
  179. SelectedRecips - SUBMIT BUTTON - Specifies recipients selected from the
  180. current "to", "cc", or "bcc" recipient list.  (Used in conjunction with
  181. "DeleteRecips" submit button to remove recipients that have already been
  182. selected.)
  183.  
  184. SelectToRecips - SUBMIT BUTTON - Adds recipients specified in the
  185. "AvailableRecips" variable to the list of selected "to" recipients.
  186.  
  187. SelectCcRecips - SUBMIT BUTTON - Adds recipients specified in the
  188. "AvailableRecips" variable to the list of selected "cc" recipients.
  189.  
  190. SelectBccRecips - SUBMIT BUTTON - Adds recipients specified in the
  191. "AvailableRecips" variable to the list of selected "bcc" recipients.
  192.  
  193. DeleteRecips - SUBMIT BUTTON - Deletes any recipients selected in the To,
  194. Cc, or Bcc boxes.  (SelectedRecips variable)
  195.  
  196. SelectAddressBook - SUBMIT BUTTON - Changes the current address book to the
  197. address book specified in the "SelectedAddressBook" variable.
  198.  
  199. SaveDList - SUBMIT BUTTON - Saves the currently selected recipients as a
  200. distribution list with a name specified by the "DListName" variable.
  201.  
  202. SavePAB - SUBMIT BUTTON - Saves a personal address book entry based on the
  203. values of the PABName and PABAddress variables.
  204.  
  205. AvailableRecipsUp - SUBMIT BUTTON - Scrolls the available recipients list up
  206. if it is larger than @@MaxRecips@@.
  207.  
  208. AvailableRecipsDown - SUBMIT BUTTON - Scrolls the available recipients list
  209. down if it is larger than @@MaxRecips@@.
  210.  
  211. AvailableRecipsTop - Specifies the current top of the recipient list if it
  212. is larger than the requested maximum.
  213.  
  214. AvailableRecipsMax - Specifies the maximum number of recipients to be
  215. displayed.  (Corresponds to @@MaxRecips@@ input in template file.)
  216.  
  217. OriginalToRecips - Contains a comma-delimited list of the currently selected
  218. "to" recipients for this message.
  219.  
  220. OriginalCcRecips - Contains a comma-delimited list of the currently selected
  221. "cc" recipients for this message.
  222.  
  223. OriginalBccRecips - Contains a comma-delimited list of the currently
  224. selected "bcc" recipients for this message.
  225.  
  226. Urgent - Set to "Yes" if the current message is flagged urgent.
  227.  
  228. ReturnReceipt - Set to "Yes" if the current message is flagged for return
  229. receipt requested.
  230.  
  231. Signature - Set to "Yes" if the current message is flagged to include a
  232. message signature.
  233.  
  234. Subject - Contains the subject of the current message.
  235.  
  236. AttachmentList - Contains a list of attachments for the current message.
  237.  
  238. AttachmentNameList - Contains a list of attachments for the current message
  239. (friendly display format).
  240.  
  241. MessageText - Contains the text of the current message.
  242.  
  243. SelectedAttachments - Allows the user to select from the list of uploaded
  244. attachments to remove any of the previously specified attachments.
  245.  
  246. SelectedAddressBook - Specifies an address book to be selected, used in
  247. conjunction with "SelectAddressBook" submit button.
  248.  
  249. AvailableRecips - Specifies address book recipients that are being selected
  250. for some action.
  251.  
  252. SearchData - Specifies data to be searched for in the address book.
  253.  
  254. DListName - Specifies the name of a distribution list if the user wishes to
  255. save the currently selected recipients as a distribution list.
  256.  
  257. PABName - Specifies a name to be given to a new personal address book
  258. entry.
  259.  
  260. PABAddress - Specifies an e-mail address to correspond to a new name in the
  261. personal address book.
  262.  
  263.  
  264. *** Attach.htm - Attachment screen ***
  265.  
  266. @@QuitURL@@ - The URL that the POST for this template is directed to.
  267.  
  268. @@Template@@ - The name of the currently selected set of templates, which is
  269. useful for locating related GIF files for the template.  (e.g., GIF files
  270. are normally referenced in a template as /html/@@Template@@/filename.gif,
  271. rather than hard-coding the template name to provide flexibility in renaming
  272. templates)
  273.  
  274. @@UserName@@ - User login name.
  275.  
  276. @@MessageSubject@@ - The subject for the current message.
  277.  
  278. @@UrgentFlag@@ - Set to "Yes" if the message is flagged urgent, "No"
  279. otherwise.
  280.  
  281. @@ReturnReceiptFlag@@ - Set to "Yes" if the message is flagged return
  282. receipt requested, "No" otherwise.
  283.  
  284. @@AddSignatureFlag@@ - Set to "Yes" if the message is flagged add signature
  285. requested, "No" otherwise.
  286.  
  287. @@AttachmentList@@ - A comma-delimited list of attachments selected for the
  288. current message.  (This field should not be displayed, but must be
  289. associated with a hidden keyword of "AttachmentList".)
  290.  
  291. @@AttachmentNameList@@ - A comma-delimited list of attachments selected for
  292. the current message.  (Friendly, display format.)
  293.  
  294. @@MessageText@@ - Text of the current message.
  295.  
  296. @@SelectedToRecipients@@ - Comma-delimited list of currently selected "to"
  297. recipients.
  298.  
  299. @@SelectedCcRecipients@@ - Comma-delimited list of currently selected "cc"
  300. recipients.
  301.  
  302. @@SelectedBccRecipients@@ - Comma-delimited list of currently selected "bcc"
  303. recipients.
  304.  
  305. @@AttachmentNames@@ - This line will be repeated for each currently selected
  306. attachment, with the name of the attachment replacing the @@ placeholder.
  307.  
  308. Special begin/end logic that allows certain lines to be included only if a
  309. particular condition is met:
  310.  
  311. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  312. automatically write carriage return/line feeds out when processing the
  313. template file.
  314.  
  315. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  316. carriage return/line feeds when processing the template file.
  317.  
  318. Post variables (many of these variables are initialized as hidden input
  319. fields, which allows state information about the current message being
  320. composed to be maintained):
  321.  
  322. CancelAttachment (or DoneAttachment) - SUBMIT BUTTON - Set to close the
  323. current window, and return to the create message screen.
  324.  
  325. NewAttachment - SUBMIT BUTTON - The name of the file being uploaded when a
  326. submit button is pressed.
  327.  
  328. AddAttachment - SUBMIT BUTTON - Set to upload the file specified in the
  329. NewAttachment field.
  330.  
  331. DeleteAttachment - SUBMIT BUTTON - When set, the attachment specified in the
  332. SelectedAttachments field will be deleted.
  333.  
  334. OriginalToRecips - Contains a comma-delimited list of the currently selected
  335. "to" recipients for this message.
  336.  
  337. OriginalCcRecips - Contains a comma-delimited list of the currently selected
  338. "cc" recipients for this message.
  339.  
  340. OriginalBccRecips - Contains a comma-delimited list of the currently
  341. selected "bcc" recipients for this message.
  342.  
  343. Urgent - Set to "Yes" if the current message is flagged urgent.
  344.  
  345. ReturnReceipt - Set to "Yes" if the current message is flagged for return
  346. receipt requested.
  347.  
  348. Signature - Set to "Yes" if the current message is flagged to include a
  349. message signature.
  350.  
  351. Subject - Contains the subject of the current message.
  352.  
  353. AttachmentList - Contains a list of attachments for the current message.
  354.  
  355. AttachmentNameList - Contains a list of attachments for the current message
  356. (friendly display format).
  357.  
  358. MessageText - Contains the text of the current message.
  359.  
  360. SelectedAttachments - Allows the user to select from the list of uploaded
  361. attachments to remove any of the previously specified attachments.
  362.  
  363.  
  364. *** Create.htm - Message create screen ***
  365.  
  366. @@IndexURL@@ - A complete URL to return to the message list screen for the
  367. current folder.
  368.  
  369. @@QuitURL@@ - A complete URL to return to the previous screen.  (Create.htm
  370. is used not only for creating a new message, but also for replying or
  371. forwarding, so the previous screen could be a message being replied to or
  372. forwarded.)
  373.  
  374. @@Template@@ - The name of the currently selected set of templates, which is
  375. useful for locating related GIF files for the template.  (e.g., GIF files
  376. are normally referenced in a template as /html/@@Template@@/filename.gif,
  377. rather than hard-coding the template name to provide flexibility in renaming
  378. templates)
  379.  
  380. @@MessageSubject@@ - Subject line of the current message.
  381.  
  382. @@UserName@@ - User login name.
  383.  
  384. @@MessageToList@@ - A comma-delimited list of the currently selected "To:"
  385. recipients.
  386.  
  387. @@MessageCcList@@ - A comma-delimited list of the currently selected "Cc:"
  388. recipients.
  389.  
  390. @@MessageBccList@@ - A comma-delimited list of the currently selected "Bcc:"
  391. recipients.
  392.  
  393. @@AttachmentList@@ - A comma-delimited list of attachments selected for the
  394. current message.  (This field should not be displayed, but must be
  395. associated with a hidden keyword of "AttachmentList".)
  396.  
  397. @@AttachmentNameList@@ - A comma-delimited list of attachments selected for
  398. the current message.  (Friendly, display format.)
  399.  
  400. @@MessageText@@ - The text for the current message.
  401.  
  402. @@ErrorMessage@@ - If an error occurred performing a particular action with
  403. the current message, the text of the error is available from this keyword.
  404.  
  405. Special begin/end logic that allows certain lines to be included only if a
  406. particular condition is met:
  407.  
  408. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  409. automatically write carriage return/line feeds out when processing the
  410. template file.
  411.  
  412. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  413. carriage return/line feeds when processing the template file.
  414.  
  415. @@BeginIfError@@ - When this keyword is encountered, any lines that follow,
  416. up to a closing @@EndIfError@@ will only be included if an error has
  417. occurred.
  418.  
  419. @@BeginIfUrgent@@ - When this keyword is encountered, any lines that follow,
  420. up to a closing @@EndIfUrgent@@ will only be included if the current message
  421. being created has been marked Urgent.
  422.  
  423. @@BeginIfReturnReceipt@@ - When this keyword is encountered, any lines that
  424. follow, up to a closing @@EndIfReturnReceipt@@ will only be included if the
  425. current message being created has been marked with return receipt
  426. requested.
  427.  
  428. @@BeginIfAddSignature@@ - When this keyword is encountered, any lines that
  429. follow, up to a closing @@EndIfAddSignature@@ will only be included if the
  430. current message being created has been marked with add signature requested.
  431.  
  432. @@BeginIfHTTPFileUploadSupported@@ - When this keyword is encountered, any
  433. lines that follow, up to a closing @@EndIfHTTPFileUploadSupported@@ will
  434. only be included if the user's web browser is known to support HTTP file
  435. uploads.
  436.  
  437. @@BeginIfAnyAttachments@@ - When this keyword is encountered, any lines that
  438. follow, up to a closing @@EndIfAnyAttachments@@ will only be included if one
  439. or more attachments have been selected for the current message.
  440.  
  441. Post variables:
  442.  
  443. ListsButton - SUBMIT BUTTON - Set if the user is requesting to enter the
  444. address book.
  445.  
  446. AttachmentButton - SUBMIT BUTTON - Set if the user is requesting to bring up
  447. the attachments screen.
  448.  
  449. SpellButton - SUBMIT BUTTON - Set if the user is requesting to spell check
  450. the current message.
  451.  
  452. DraftButton - SUBMIT BUTTON - Set if the user is requesting to save the
  453. current message as a draft.
  454.  
  455. SendButton (or SendButton2) - SUBMIT BUTTON - Set if the user is requesting
  456. to send the current message.
  457.  
  458. ToList - Contains a comma-delimited list of the currently selected "to"
  459. recipients for this message.
  460.  
  461. CcList - Contains a comma-delimited list of the currently selected "cc"
  462. recipients for this message.
  463.  
  464. BccList - Contains a comma-delimited list of the currently selected "bcc"
  465. recipients for this message.
  466.  
  467. Urgent - Set to "Yes" if the current message is flagged urgent.
  468.  
  469. ReturnReceipt - Set to "Yes" if the current message is flagged for return
  470. receipt requested.
  471.  
  472. Signature - Set to "Yes" if the current message is flagged to include a
  473. message signature.
  474.  
  475. Subject - Contains the subject of the current message.
  476.  
  477. AttachmentList - Contains a list of attachments for the current message.
  478.  
  479. MessageText - Contains the text of the current message.
  480.  
  481.  
  482. *** DelFold.htm - Delete folder screen ***
  483.  
  484. @@IndexURL@@ (or @@QuitURL@@) - URL to return to the message list.
  485.  
  486. @@Template@@ - The name of the currently selected set of templates, which is
  487. useful for locating related GIF files for the template.  (e.g., GIF files
  488. are normally referenced in a template as /html/@@Template@@/filename.gif,
  489. rather than hard-coding the template name to provide flexibility in renaming
  490. templates)
  491.  
  492. @@UserName@@ - User login name.
  493.  
  494. @@FolderName@@ - Name of the folder being deleted
  495.  
  496. @@FolderDescription@@ - Description of the folder being deleted.
  497.  
  498. @@MessageCount@@ - Number of messages that exist in the folder to be
  499. deleted.
  500.  
  501. Post variables:
  502.  
  503. ConfirmDeleteFolder - SUBMIT BUTTON - Indicates that the folder specified by
  504. the variable "FolderToDelete" should be deleted.
  505.  
  506. FolderToDelete - Name of the folder to be deleted.  (Hidden field)
  507.  
  508.  
  509. *** FileMail.htm - File Message screen ***
  510.  
  511. @@IndexURL@@ - URL to return to the previous screen.
  512.  
  513. @@MessageID@@ - Identifies the message id of the message to be filed.
  514. (MSG:##)
  515.  
  516. @@MessageRealID@@ - Identifies the mail system dependent ID of the message
  517. to be filed.
  518.  
  519. @@Template@@ - The name of the currently selected set of templates, which is
  520. useful for locating related GIF files for the template.  (e.g., GIF files
  521. are normally referenced in a template as /html/@@Template@@/filename.gif,
  522. rather than hard-coding the template name to provide flexibility in renaming
  523. templates)
  524.  
  525. @@UserName@@ - User login name.
  526.  
  527. @@ErrorMessage@@ - If an error occurred, this text is replaced with a text
  528. string describing the error.
  529.  
  530. @@FolderList@@ - This line is repeated for each folder, with the folder
  531. names replacing the @@ placeholder.
  532.  
  533. Special begin/end logic that allows certain lines to be included only if a
  534. particular condition is met:
  535.  
  536. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  537. automatically write carriage return/line feeds out when processing the
  538. template file.
  539.  
  540. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  541. carriage return/line feeds when processing the template file.
  542.  
  543. @@BeginIfError@@ - When this keyword is encountered, any lines that follow,
  544. up to a closing @@EndIfError@@ will only be included if there is an error
  545. message to be displayed.
  546.  
  547. Post variables:
  548.  
  549. FileInFolder - SUBMIT BUTTON - When set the message identified by the
  550. "MessageID" and "MessageRealID" variables will be filed in the folder
  551. referenced by the variable name "FolderName".
  552.  
  553. CreateAndFileInFolder - SUBMIT BUTTON - When set, the folder referenced in
  554. the "CreateFolderName" and "CreateFolderDescription" variables will be
  555. created.
  556.  
  557. MessageID - Contains the message id of the message to be filed (MSG:##)
  558. (hidden field)
  559.  
  560. MessageRealID - Contains the mail system dependent ID of the message to be
  561. filed.  (hidden field)
  562.  
  563. CreateFolderName - Contains the name of a new folder to be created.
  564.  
  565. CreateFolderDescription - Contains the description for a new folder to be
  566. created.  (If the mail interface supports folder descriptions.)
  567.  
  568. FolderName - Specifies the name of a folder to be selected or deleted
  569. depending on which submit button was selected.
  570.  
  571.  
  572. *** Folders.htm - Select folder screen ***
  573.  
  574. @@IndexURL@@ - URL to return to the message list screen.
  575.  
  576. @@Template@@ - The name of the currently selected set of templates, which is
  577. useful for locating related GIF files for the template.  (e.g., GIF files
  578. are normally referenced in a template as /html/@@Template@@/filename.gif,
  579. rather than hard-coding the template name to provide flexibility in renaming
  580. templates)
  581.  
  582. @@UserName@@ - User login name.
  583.  
  584. @@ErrorMessage@@ - If an error occurred, this text is replaced with a text
  585. string describing the error.
  586.  
  587. @@FolderList@@ - This line is repeated for each folder, with the folder
  588. names replacing the @@ placeholder.
  589.  
  590. Special begin/end logic that allows certain lines to be included only if a
  591. particular condition is met:
  592.  
  593. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  594. automatically write carriage return/line feeds out when processing the
  595. template file.
  596.  
  597. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  598. carriage return/line feeds when processing the template file.
  599.  
  600. @@BeginIfError@@ - When this keyword is encountered, any lines that follow,
  601. up to a closing @@EndIfError@@ will only be included if there is an error
  602. message to be displayed.
  603.  
  604. Post variables:
  605.  
  606. SelectFolder - SUBMIT BUTTON - When set the message list will be displayed
  607. with the current folder set to the folder referenced in the "FolderName"
  608. variable.
  609.  
  610. DeleteFolder - SUBMIT BUTTON - When set, the folder referenced in the
  611. "FolderName" variable will be deleted.  (A confirm delete screen will be
  612. displayed before actual deletion.)
  613.  
  614. CreateFolder - SUBMIT BUTTON - When set, the folder referenced in the
  615. "CreateFolderName" and "CreateFolderDescription" variables will be created.
  616.  
  617. CreateFolderName - Contains the name of a new folder to be created.
  618.  
  619. CreateFolderDescription - Contains the description for a new folder to be
  620. created.  (If the mail interface supports folder descriptions.)
  621.  
  622. FolderName - Specifies the name of a folder to be selected or deleted
  623. depending on which submit button was selected.
  624.  
  625.  
  626. *** Help.htm - On-line help ***
  627.  
  628. This file does not include any replaceable parameters.
  629.  
  630.  
  631. *** Login.htm - Login screen ***
  632.  
  633. @@ErrorMessage@@ - If a login error occurred, this text is replaced with a
  634. text string describing the error.
  635.  
  636. @@RequestURL@@ - If the user was making a request, but the WebMail server no
  637. longer considered the user to be logged in, this field contains the URL of
  638. the request that the user was attempting to access, so that they will be
  639. directed to this URL after login.
  640.  
  641. @@ContinueURL@@ - The URL that the POST request for logging in is directed
  642. to.
  643.  
  644. @@Template@@ - The name of the currently selected set of templates, which is
  645. useful for locating related GIF files for the template.  (e.g., GIF files
  646. are normally referenced in a template as /html/@@Template@@/filename.gif,
  647. rather than hard-coding the template name to provide flexibility in renaming
  648. templates)
  649.  
  650. @@UserName@@ - User login name or blank to intialize the user name field.
  651.  
  652. @@MailServerList@@ - If the server is configured to pass-through to multiple
  653. servers, this line is repeated for each of the pass-through servers.
  654.  
  655. Special begin/end logic that allows certain lines to be included only if a
  656. particular condition is met:
  657.  
  658. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  659. automatically write carriage return/line feeds out when processing the
  660. template file.
  661.  
  662. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  663. carriage return/line feeds when processing the template file.
  664.  
  665. @@BeginIfServerSelect@@ - When this keyword is encountered, any lines that
  666. follow, up to a closing @@EndIfServerSelect@@ will only be included if
  667. WebMail is configured for multiple pass-through servers.
  668.  
  669. @@BeginIfError@@ - When this keyword is encountered, any lines that follow,
  670. up to a closing @@EndIfError@@ will only be included if there is an error
  671. message to be displayed.
  672.  
  673. Post variables:
  674.  
  675. DoLogin - SUBMIT BUTTON - Set to indicate that this is a login request to be
  676. processed.
  677.  
  678. RequestURL - If the user was making a request, but the WebMail server no
  679. longer considered the user to be logged in, this field contains the URL of
  680. the request that the user was attempting to access, so that they will be
  681. directed to this URL after login.
  682.  
  683. SaveUser - If the user was making a request, but the WebMail server no
  684. longer considered the user to be logged in, this field contains the user
  685. name associated with the request.  If the user logs in with a different user
  686. name than specified here, then RequestURL is ignored.
  687.  
  688. User - The name of the user logging in.
  689.  
  690. Password - The password for the user logging in.
  691.  
  692. MailServer - If the WebMail server is configured for multiple pass-through
  693. servers, this field contains the server that the user selected.
  694.  
  695.  
  696. *** Options.htm - User Options screen ***
  697.  
  698. @@ErrorMessage@@ - If a login error occurred, this text is replaced with a
  699. text string describing the error.
  700.  
  701. @@Template@@ - The name of the currently selected set of templates, which is
  702. useful for locating related GIF files for the template.  (e.g., GIF files
  703. are normally referenced in a template as /html/@@Template@@/filename.gif,
  704. rather than hard-coding the template name to provide flexibility in renaming
  705. templates)
  706.  
  707. @@UserName@@ - User login name.
  708.  
  709. @@FullName@@ - Full name of the current user.
  710.  
  711. @@QuitURL@@ - Full URL to return to the previous screen.
  712.  
  713. @@RetainDeletedMessages@@ - Number of messages to be retained in the user's
  714. deleted folder.
  715.  
  716. @@RetainOutboxDays@@ - Number of days to retain messages in the user's
  717. outbox folder.
  718.  
  719. @@MessagesPerPage@@ - Number of messages to include per page when building
  720. the message list display.
  721.  
  722. @@IMAPFolderPrefix@@ - For IMAP users, their IMAP folder prefix.
  723.  
  724. @@MessageSignature@@ - Message signature text.
  725.  
  726. @@HTMLProfileList@@ - Repeated for each HTML template set defined, with the
  727. template name and description replacing the @@ placeholder.
  728.  
  729. Special begin/end logic that allows certain lines to be included only if a
  730. particular condition is met:
  731.  
  732. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  733. automatically write carriage return/line feeds out when processing the
  734. template file.
  735.  
  736. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  737. carriage return/line feeds when processing the template file.
  738.  
  739. @@BeginIfError@@ - When this keyword is encountered, any lines that follow,
  740. up to a closing @@EndIfError@@ will only be included if there is an error
  741. message to be displayed.
  742.  
  743. @@BeginIfFoldersSupported@@ - When this keyword is encountered, any lines
  744. that follow, up to a closing @@EndIfFoldersSupported@@ will only be included
  745. if there is folder support for the current user.
  746.  
  747. @@BeginIfViewHeaders@@ - When this keyword is encountered, any lines that
  748. follow, up to a closing @@EndIfViewHeaderst@@ will only be included if the
  749. user's option are set to view headers.
  750.  
  751. @@BeginIfNotViewHeaders@@ - When this keyword is encountered, any lines that
  752. follow, up to a closing @@EndIfNotViewHeaderst@@ will only be included if
  753. the user's option are set to not view headers.
  754.  
  755. @@BeginIfUseMonospacedFont@@ - When this keyword is encountered, any lines
  756. that follow, up to a closing @@EndIfUseMonospacedFont@@ will only be
  757. included if the user's option are set to use a monospaced (non-proportional)
  758. font.
  759.  
  760. @@BeginIfNotUseMonospacedFont@@ - When this keyword is encountered, any
  761. lines that follow, up to a closing @@EndIfNotUseMonospacedFont@@ will only
  762. be included if the user's option are not set to use a monospaced
  763. (non-proportional) font.
  764.  
  765. @@BeginIfPreviewMode@@ - When this keyword is encountered, any lines that
  766. follow, up to a closing @@EndIfPreviewMode@@ will only be included if the
  767. user's option are set to read messages in preview mode.
  768.  
  769. @@BeginIfNotPreviewMode@@ - When this keyword is encountered, any lines that
  770. follow, up to a closing @@EndIfNotPreviewMode@@ will only be included if the
  771. user's option are not set to read messages in preview mode.
  772.  
  773. @@BeginIfAddSignature@@ - When this keyword is encountered, any lines that
  774. follow, up to a closing @@EndIfAddSignature@@ will only be included if the
  775. user's option are set to add a signature to mail messages by default.
  776.  
  777. @@BeginIfNotAddSignature@@ - When this keyword is encountered, any lines
  778. that follow, up to a closing @@EndIfNotAddSignature@@ will only be included
  779. if the user's option are not set to add a signature to mail messages by
  780. default.
  781.  
  782. @@BeginIfUserType@@=XXXX - When this keyword is encountered, any lines that
  783. follow, up to a closing @@EndIfUserType@@ will only be included if the
  784. current user is of the mail system type XXXX.
  785.  
  786. Post variables:
  787.  
  788. OptionsOK - SUBMIT BUTTON - Indicates that the user has requested options to
  789. be updated, and the option variables described in this section will be
  790. processed.
  791.  
  792. ViewHeaders - Set to "Yes" to view message headers.
  793.  
  794. UseMonoSpacedFont - Set to "Yes" to use a mono-spaced font.
  795.  
  796. PreviewMode - Set to "Yes" to enable preview mode.  (Messages are not
  797. automatically flagged as read in that mode.)
  798.  
  799. AddSignature - Set to "Yes" to add a signature to messages by default.
  800.  
  801. KeepDeleted - Specifies the number of messages to maintain in the deleted
  802. mail folder.
  803.  
  804. KeepOutbox - Specifies the number of days to retain messages in the outbox
  805. mail folder.
  806.  
  807. MessagesPage - Specifies the number of messages to include per page in the
  808. message list.
  809.  
  810. FullName - Specifies the user's full name (for interfaces that allow this to
  811. be set).
  812.  
  813. NewPassword1 - Specifies the user's new password (for interfaces that allow
  814. the password to be changed).
  815.  
  816. NewPassword2 - Confirms the user's new password.
  817.  
  818. IMAPFolderPrefix - For IMAP users, specifies the current user's mail folder
  819. prefix.
  820.  
  821.  
  822. *** ReadMail.htm - Read message screen ***
  823.  
  824. @@MessageIndexURL@@ - URL to return to the message list screen for the
  825. current folder.
  826.  
  827. @@MessageListURL@@ - URL to return to the message list screen for the
  828. current folder, but to return to the nearest page.  (e.g., if the current
  829. message is beyond the first page of messages, this URL will be
  830. @@MessageIndexURL@@ plus /TOPMSG:##).
  831.  
  832. @@MessagePrevoiusURL@@ - Specifies an extension to @@MessageIndexURL@@ which
  833. points to the previous message (e.g., /MSG:30)
  834.  
  835. @@MessageNextURL@@ - Specifies an extension to @@MessageIndexURL@@ which
  836. points to the next message (e.g., /MSG:32)
  837.  
  838. @@Template@@ - The name of the currently selected set of templates, which is
  839. useful for locating related GIF files for the template.  (e.g., GIF files
  840. are normally referenced in a template as /html/@@Template@@/filename.gif,
  841. rather than hard-coding the template name to provide flexibility in renaming
  842. templates)
  843.  
  844. @@UserName@@ - User login name.
  845.  
  846. @@MessageDateTime@@ - String that displays the date/time that the selected
  847. message was sent.
  848.  
  849. @@MessageFrom@@ - Sender of the selected message.
  850.  
  851. @@MessageSubject@@ - Subject of the selected message.
  852.  
  853. @@MessageNumber@@ - Index number of the current message.
  854.  
  855. @@MessageCount@@ - Count of the number of messages in the current folder.
  856.  
  857. @@MessageID@@ - Specifies an extension to @@MessageIndexURL@@ to select the
  858. current message (e.g., /MSG:31)
  859.  
  860. @@MessageRealID@@ - Specifies a mail system dependent unique ID for the
  861. current message.  The MessageRealID variable is normally initialized with
  862. this value, so that delete requests can ensure that the correct message is
  863. being deleted.
  864.  
  865. @@MessageToList@@ - The current line is repeated for each "to" recipient of
  866. the message, with the recipient taking the place of the @@ placeholder.
  867.  
  868. @@MessageCcList@@ - The current line is repeated for each "cc" recipient of
  869. the message, with the recipient taking the place of the @@ placeholder.
  870.  
  871. @@MessageBccList@@ - The current line is repeated for each "bcc" recipient
  872. of the message, with the recipient taking the place of the @@ placeholder.
  873.  
  874. @@MessageBody@@ - The text of the message is inserted here.
  875.  
  876. @@MessageAttachmentList@@ - The current line is repeated for each attachment
  877. associated with the message, with the attachment name taking the place of
  878. the @@ placeholder.  This line can also include a
  879. @@MessageAttachmentListURL@@ variable which will be replaced with a URL that
  880. can be used to request the associated attachment directly.
  881.  
  882. Special begin/end logic that allows certain lines to be included only if a
  883. particular condition is met:
  884.  
  885. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  886. automatically write carriage return/line feeds out when processing the
  887. template file.
  888.  
  889. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  890. carriage return/line feeds when processing the template file.
  891.  
  892. @@BeginIfViewHeaders@@ - When this keyword is encountered, any lines that
  893. follow, up to a closing @@EndIfViewHeaders@@ will only be included if the
  894. user's options are currently set to display message headers.
  895.  
  896. @@BeginIfNotViewHeaders@@ - When this keyword is encountered, any lines that
  897. follow, up to a closing @@EndIfNotViewHeaders@@ will only be included if the
  898. user's options are currently not set to display message headers.
  899.  
  900. @@BeginIfUseMonospacedFont@@ - When this keyword is encountered, any lines
  901. that follow, up to a closing @@EndIfUseMonospacedFont@@ will only be
  902. included if the user's options are currently set to use a monospaced (fixed
  903. pitch) font.
  904.  
  905. @@BeginIfNotUseMonospacedFont@@ - When this keyword is encountered, any
  906. lines that follow, up to a closing @@EndIfNotUseMonospacedFont@@ will only
  907. be included if the user's options are currently set to not use a monospaced
  908. (fixed pitch) font.
  909.  
  910. @@BeginIfResend@@ - When this keyword is encountered, any lines that follow,
  911. up to a closing @@EndIfResend@@ will only be included if the current user is
  912. the sender of this message.  (This is used to give the user an option to
  913. "resend" the message.)
  914.  
  915. @@BeginIfNotResend@@ - When this keyword is encountered, any lines that
  916. follow, up to a closing @@EndIfNotResend@@ will only be included if the
  917. current user is not the sender of this message.
  918.  
  919. @@BeginIfFoldersSupported@@ - When this keyword is encountered, any lines
  920. that follow, up to a closing @@EndIfFoldersSupported@@ will only be included
  921. if folders are supported for the current user.
  922.  
  923. @@BeginIfDraft@@ - When this keyword is encountered, any lines that follow,
  924. up to a closing @@EndIfDraft@@ will only be included if the current message
  925. has a draft attribute.
  926.  
  927. @@BeginIfNotDraft@@ - When this keyword is encountered, any lines that
  928. follow, up to a closing @@EndIfNotDraft@@ will only be included if the
  929. current message does not have a draft attribute.
  930.  
  931. @@BeginIfUrgent@@ - When this keyword is encountered, any lines that follow,
  932. up to a closing @@EndIfUrgent@@ will only be included if the current message
  933. has an urgent attribute.
  934.  
  935. @@BeginIfUnread@@ - When this keyword is encountered, any lines that follow,
  936. up to a closing @@EndIfUnread@@ will only be included if the current message
  937. has not been read.
  938.  
  939. @@BeginIfRegistered@@ - When this keyword is encountered, any lines that
  940. follow, up to a closing @@EndIfRegistered@@ will only be included if the
  941. current message has return receipt requested.
  942.  
  943. @@BeginIfNotUrgent@@ - When this keyword is encountered, any lines that
  944. follow, up to a closing @@EndIfNotUrgent@@ will only be included if the
  945. current message does not have an urgent attribute.
  946.  
  947. @@BeginIfNotUnread@@ - When this keyword is encountered, any lines that
  948. follow, up to a closing @@EndIfNotUnread@@ will only be included if the
  949. current message has previously been read.
  950.  
  951. @@BeginIfNotRegistered@@ - When this keyword is encountered, any lines that
  952. follow, up to a closing @@EndIfNotRegistered@@ will only be included if the
  953. current message does not have return receipt requested.
  954.  
  955. @@BeginIfNumRecips>=##@@ - When this keyword is encountered, any lines that
  956. follow, up to a closing @@EndIfNumRecips@@ will only be included if the
  957. number of recipients of the message is greater than, less than, or equal to
  958. the specified number.  This allows templates to use drop down lists to
  959. display message recipients when there are many recipients, but just a text
  960. display when a message was sent to only one recipient.
  961.  
  962. @@BeginIfAnyCcRecips@@ - When this keyword is encountered, any lines that
  963. follow, up to a closing @@EndIfAnyCcRecips@@ will only be included if the
  964. current message has one or more "cc" recipients.
  965.  
  966. @@BeginIfAnyAttachments@@ - When this keyword is encountered, any lines that
  967. follow, up to a closing @@EndIfAnyAttachments@@ will only be included if the
  968. current message has one or more attachments.
  969.  
  970. Post variables:
  971.  
  972. Delete - SUBMIT BUTTON - Set to delete the current message, based on the
  973. values of the "MessageID" and "MessageRealID" variables.
  974.  
  975. AddSenderToPAB - SUBMIT BUTTON - Set to add the sender of the current
  976. message to the user's personal address book, based on the value of the
  977. "MessageFrom" variable.
  978.  
  979. UpdateMessageStatus - SUBMIT BUTTON - Set to update the current status of
  980. the e-mail message, based on the value of the "Urgent" and "New" variables.
  981.  
  982. MessageFrom - Hidden field that contains the "From" field of the message.
  983. (used in conjunction with "AddSenderToPAB" request)
  984.  
  985. MessageID - Hidden input field that contains the simple message id (MSG:##)
  986. of the current message.  (used in conjunction with "Delete" request)
  987.  
  988. MessageRealID - Hidden input field that contains the mail system dependent
  989. message ID for the current message.  (used in conjunction with "Delete"
  990. request)
  991.  
  992. Urgent - Set to "Yes" to mark the current message as urgent.
  993.  
  994. New - Set to "Yes" to mark the current message as unread/new.
  995.  
  996. ReadMail - Hidden input field to signal that the request is coming from the
  997. read message screen.
  998.  
  999.  
  1000. *** Search.htm - Search messages screen ***
  1001.  
  1002. @@IndexURL@@ (or @@QuitURL@@) - URL to return to the message list screen.
  1003.  
  1004. @@SearchURL@@ - URL to post search request to.
  1005.  
  1006. @@Template@@ - The name of the currently selected set of templates, which is
  1007. useful for locating related GIF files for the template.  (e.g., GIF files
  1008. are normally referenced in a template as /html/@@Template@@/filename.gif,
  1009. rather than hard-coding the template name to provide flexibility in renaming
  1010. templates)
  1011.  
  1012. @@UserName@@ - User login name.
  1013.  
  1014. @@FromDateList@@ - Initializes options list for each month/year of the past
  1015. 3 years.
  1016.  
  1017. @@ToDateList@@ - Initializes options list for each month/year of the past 3
  1018. years.
  1019.  
  1020. @@FolderList@@ - The current line in the template will be repeated for each
  1021. mail folder that the user has, with the text @@FolderList@@ replaced by a
  1022. folder name.
  1023.  
  1024.  
  1025. Special begin/end logic that allows certain lines to be included only if a
  1026. particular condition is met:
  1027.  
  1028. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  1029. automatically write carriage return/line feeds out when processing the
  1030. template file.
  1031.  
  1032. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  1033. carriage return/line feeds when processing the template file.
  1034.  
  1035. Post variables:
  1036.  
  1037. DoSearch - SUBMIT BUTTON - Set to indicate that a search should be
  1038. performed.
  1039.  
  1040. From - Set to text to be searched for in the from field of messages.
  1041.  
  1042. Text - Set to text to be searched for in the message text or subject field
  1043. of messages.
  1044.  
  1045. TextMatch - Set to "And" if the user requested that all keywords must be
  1046. found, or "Or" if the user requested that at least one keyword must be
  1047. found.
  1048.  
  1049. FromDate - Set to the mm/yy to start search with.
  1050.  
  1051. ToDate - Set to the mm/yy to end search with.
  1052.  
  1053. Folder - Set to the name of the folder to be searched.
  1054.  
  1055.  
  1056. *** Spell.htm - Spell check screen ***
  1057.  
  1058. @@ReturnURL@@ (or @@RequestURL@@) - The URL that the POST for this template
  1059. is directed to.
  1060.  
  1061. @@Template@@ - The name of the currently selected set of templates, which is
  1062. useful for locating related GIF files for the template.  (e.g., GIF files
  1063. are normally referenced in a template as /html/@@Template@@/filename.gif,
  1064. rather than hard-coding the template name to provide flexibility in renaming
  1065. templates)
  1066.  
  1067. @@UserName@@ - User login name.
  1068.  
  1069. @@MessageSubject@@ - The subject for the current message.
  1070.  
  1071. @@UrgentFlag@@ - Set to "Yes" if the message is flagged urgent, "No"
  1072. otherwise.
  1073.  
  1074. @@ReturnReceiptFlag@@ - Set to "Yes" if the message is flagged return
  1075. receipt requested, "No" otherwise.
  1076.  
  1077. @@AddSignatureFlag@@ - Set to "Yes" if the message is flagged add signature
  1078. requested, "No" otherwise.
  1079.  
  1080. @@AttachmentList@@ - A comma-delimited list of attachments selected for the
  1081. current message.  (This field should not be displayed, but must be
  1082. associated with a hidden keyword of "AttachmentList".)
  1083.  
  1084. @@AttachmentNameList@@ - A comma-delimited list of attachments selected for
  1085. the current message.  (Friendly, display format.)
  1086.  
  1087. @@MessageText@@ - Text of the current message.
  1088.  
  1089. @@SelectedToRecipients@@ - Comma-delimited list of currently selected "to"
  1090. recipients.
  1091.  
  1092. @@SelectedCcRecipients@@ - Comma-delimited list of currently selected "cc"
  1093. recipients.
  1094.  
  1095. @@SelectedBccRecipients@@ - Comma-delimited list of currently selected "bcc"
  1096. recipients.
  1097.  
  1098. @@MisspellCount@@ - Count of possibly misspelled words.
  1099.  
  1100. @@MaxWordHRef@@ - Contains a relative URL that takes you to the bottom of
  1101. the current form (after all of the misspelled words).
  1102.  
  1103. @@MessageTextDisplay@@ - Text of the current message formatted for display
  1104. with possibly misspelled words highlighted as links to relative URLs that
  1105. appear later in the template.
  1106.  
  1107. Special begin/end logic that allows certain lines to be included only if a
  1108. particular condition is met:
  1109.  
  1110. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  1111. automatically write carriage return/line feeds out when processing the
  1112. template file.
  1113.  
  1114. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  1115. carriage return/line feeds when processing the template file.
  1116.  
  1117. @@BeginIfSpellingOK@@ - When this keyword is encountered, any lines that
  1118. follow, up to a closing @@EndIfSpellingOK@@ will only be included if no
  1119. possible spelling errors were encountered.
  1120.  
  1121. @@BeginIfSpellingNotOK@@ - When this keyword is encountered, any lines that
  1122. follow, up to a closing @@EndIfSpellingNotOK@@ will only be included if at
  1123. least one possible spelling errors was encountered.
  1124.  
  1125. @@BeginRepeat@@ - When this keyword is encountered, any lines that follow,
  1126. up to a closing @@EndRepeat@@ will be included, and repeated for each
  1127. possible spelling error.
  1128.  
  1129. Special message list keywords available for each possible spelling error
  1130. (between @@BeginRepeat@@ and @@EndRepeat@@ only):
  1131.  
  1132. @@WordHRef@@ - A relative URL to go to the current word.
  1133.  
  1134. @@Word@@ - The possibly misspelled word.
  1135.  
  1136. @@WordLen@@ - The length (number of characters) of the possibly misspelled
  1137. word.
  1138.  
  1139. @@PreviousWords@@ - Several words that appear before the current word to
  1140. provide context information.
  1141.  
  1142. @@NextWords@@ - Several words that appear after the current word to provide
  1143. context information.
  1144.  
  1145. @@NextWordHRef@@ - A relative URL to go to the next of the possibly
  1146. misspelled words.
  1147.  
  1148. @@BeginIfSuggestedWords@@ - When this keyword is encountered, any lines that
  1149. follow, up to a closing @@EndIfSuggestedWords@@ will only be included if the
  1150. spelling dictionary has found one or more suggested corrections for the
  1151. possibly misspelled word.
  1152.  
  1153. @@SuggestedWords@@ - The current line will be repeated for each suggested
  1154. word from the spelling dictionary replacing the @@ placeholder.
  1155.  
  1156. Post variables (many of these variables are initialized as hidden input
  1157. fields, which allows state information about the current message being
  1158. composed to be maintained):
  1159.  
  1160. SpellOkButton - SUBMIT BUTTON - Submit any changes on the current screen,
  1161. and return to the create message screen.
  1162.  
  1163. OriginalToRecips - Contains a comma-delimited list of the currently selected
  1164. "to" recipients for this message.
  1165.  
  1166. OriginalCcRecips - Contains a comma-delimited list of the currently selected
  1167. "cc" recipients for this message.
  1168.  
  1169. OriginalBccRecips - Contains a comma-delimited list of the currently
  1170. selected "bcc" recipients for this message.
  1171.  
  1172. Urgent - Set to "Yes" if the current message is flagged urgent.
  1173.  
  1174. ReturnReceipt - Set to "Yes" if the current message is flagged for return
  1175. receipt requested.
  1176.  
  1177. Signature - Set to "Yes" if the current message is flagged to include a
  1178. message signature.
  1179.  
  1180. Subject - Contains the subject of the current message.
  1181.  
  1182. AttachmentList - Contains a list of attachments for the current message.
  1183.  
  1184. AttachmentNameList - Contains a list of attachments for the current message
  1185. (friendly display format).
  1186.  
  1187. MessageText - Contains the text of the current message.
  1188.  
  1189. @@WordHRef@@ - WebMail automatically generates the name of this input field,
  1190. which is repeated for each possible misspelling.  It is a text box that
  1191. allows the user to correct the spelling.
  1192.  
  1193. Action@@WordHRef@@ - WebMail automatically generates the name of this input
  1194. field, which is repeated for each possible misspelling.  Set to one of the
  1195. following values, depending on the action selected by the user:  "Accept" =
  1196. Accept the word as displayed in the text box; "AddWord" = Accept the word as
  1197. displayed in the text box and add it to the user's personal spelling
  1198. dictionary; "SelectSuggestion" = Select the highlighted word from the
  1199. suggested words list.
  1200.  
  1201. Suggest@@WordHRef@@ - WebMail automatically generates the name of this input
  1202. field, which is repeated for each possible misspelling.  If
  1203. Action@@WordHRef@@ is set to "SelectSuggestion", then this field contains
  1204. the word that will be used to replace the current suspect word.
  1205.  
  1206.  
  1207. *** VRecips.htm - Validate recipients screen (used only in the VIM and MAPI interfaces) ***
  1208.  
  1209. @@ReturnURL@@ (or @@RequestURL@@) - The URL that the POST for this template
  1210. is directed to.
  1211.  
  1212. @@Template@@ - The name of the currently selected set of templates, which is
  1213. useful for locating related GIF files for the template.  (e.g., GIF files
  1214. are normally referenced in a template as /html/@@Template@@/filename.gif,
  1215. rather than hard-coding the template name to provide flexibility in renaming
  1216. templates)
  1217.  
  1218. @@UserName@@ - User login name.
  1219.  
  1220. @@MessageSubject@@ - The subject for the current message.
  1221.  
  1222. @@UrgentFlag@@ - Set to "Yes" if the message is flagged urgent, "No"
  1223. otherwise.
  1224.  
  1225. @@ReturnReceiptFlag@@ - Set to "Yes" if the message is flagged return
  1226. receipt requested, "No" otherwise.
  1227.  
  1228. @@AddSignatureFlag@@ - Set to "Yes" if the message is flagged add signature
  1229. requested, "No" otherwise.
  1230.  
  1231. @@AttachmentList@@ - A comma-delimited list of attachments selected for the
  1232. current message.  (This field should not be displayed, but must be
  1233. associated with a hidden keyword of "AttachmentList".)
  1234.  
  1235. @@AttachmentNameList@@ - A comma-delimited list of attachments selected for
  1236. the current message.  (Friendly, display format.)
  1237.  
  1238. @@MessageText@@ - Text of the current message.
  1239.  
  1240. @@SelectedToRecipients@@ - Comma-delimited list of currently selected "to"
  1241. recipients.
  1242.  
  1243. @@SelectedCcRecipients@@ - Comma-delimited list of currently selected "cc"
  1244. recipients.
  1245.  
  1246. @@SelectedBccRecipients@@ - Comma-delimited list of currently selected "bcc"
  1247. recipients.
  1248.  
  1249. @@BadRecipList@@ - List of recipients that were rejected by the mail system
  1250. when attempting to send.
  1251.  
  1252. Special begin/end logic that allows certain lines to be included only if a
  1253. particular condition is met:
  1254.  
  1255. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  1256. automatically write carriage return/line feeds out when processing the
  1257. template file.
  1258.  
  1259. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  1260. carriage return/line feeds when processing the template file.
  1261.  
  1262. Post variables (many of these variables are initialized as hidden input
  1263. fields, which allows state information about the current message being
  1264. composed to be maintained):
  1265.  
  1266. ReturnToMessage - SUBMIT BUTTON - Set if the user wishes to return to the
  1267. create message screen.
  1268.  
  1269. GoToAddressBook - SUBMIT BUTTON - Set if the user wishes to return to the
  1270. address book screen.
  1271.  
  1272. OriginalToRecips - Contains a comma-delimited list of the currently selected
  1273. "to" recipients for this message.
  1274.  
  1275. OriginalCcRecips - Contains a comma-delimited list of the currently selected
  1276. "cc" recipients for this message.
  1277.  
  1278. OriginalBccRecips - Contains a comma-delimited list of the currently
  1279. selected "bcc" recipients for this message.
  1280.  
  1281. Urgent - Set to "Yes" if the current message is flagged urgent.
  1282.  
  1283. ReturnReceipt - Set to "Yes" if the current message is flagged for return
  1284. receipt requested.
  1285.  
  1286. Signature - Set to "Yes" if the current message is flagged to include a
  1287. message signature.
  1288.  
  1289. Subject - Contains the subject of the current message.
  1290.  
  1291. AttachmentList - Contains a list of attachments for the current message.
  1292.  
  1293. AttachmentNameList - Contains a list of attachments for the current message
  1294. (friendly display format).
  1295.  
  1296. MessageText - Contains the text of the current message.
  1297.  
  1298.  
  1299. *** WebMail.htm - Message index/list screen ***
  1300.  
  1301. @@IndexURL@@ - The base URL for the message list display, including a folder
  1302. reference if the folder is other than the user's New-Mail or Inbox folder
  1303. (e.g., /MBX/username/ID=????????)
  1304.  
  1305. @@PageCurrentURL@@ - If the user has scrolled down in the message list, this
  1306. specifies an extension to @@IndexURL@@ which specifies the top of the
  1307. current message list (e.g., /TOPMSG:20)
  1308.  
  1309. @@PageUpURL@@ - This specifies an extension to @@IndexURL@@ which specifies
  1310. the previous page of messages (e.g., /TOPMSG:20)
  1311.  
  1312. @@PageDownURL@@ - This specifies an extension to @@IndexURL@@ which
  1313. specifies the next page of messages (e.g., /TOPMSG:20)
  1314.  
  1315. @@NewMailURL@@ - The base URL for the message list display of the user's
  1316. New-Mail or Inbox folder.
  1317.  
  1318. @@LogoutURL@@ - A complete URL for logging out of the system.
  1319.  
  1320. @@Template@@ - The name of the currently selected set of templates, which is
  1321. useful for locating related GIF files for the template.  (e.g., GIF files
  1322. are normally referenced in a template as /html/@@Template@@/filename.gif,
  1323. rather than hard-coding the template name to provide flexibility in renaming
  1324. templates)
  1325.  
  1326. @@UserName@@ - User login name.
  1327.  
  1328. @@FullName@@ - The full name configured for the user.
  1329.  
  1330. @@MailAddress@@ - User's e-mail address.
  1331.  
  1332. @@CurrentFolder@@ - The name of the currently selected mail folder.
  1333.  
  1334. @@TopMsg@@ - The number of the top message displayed in the current list.
  1335. (starts at 1)
  1336.  
  1337. @@BottomMsg@@ - The number of the last message displayed in the current
  1338. list.
  1339.  
  1340. @@MessageCount@@ - The number of messages in the currently selected mail
  1341. folder.
  1342.  
  1343. @@FolderList@@ - The current line in the template will be repeated for each
  1344. mail folder that the user has, with the text @@FolderList@@ replaced by a
  1345. folder name.
  1346.  
  1347. Special begin/end logic that allows certain lines to be included only if a
  1348. particular condition is met:
  1349.  
  1350. @@BeginNoCrlf@@ - If this keyword is encountered, WebMail will not
  1351. automatically write carriage return/line feeds out when processing the
  1352. template file.
  1353.  
  1354. @@EndNoCrlf@@ - If this keyword is encountered, WebMail will resume writing
  1355. carriage return/line feeds when processing the template file.
  1356.  
  1357. @@BeginIfMainFolder@@ - When this keyword is encountered, any lines that
  1358. follow, up to a closing @@EndIfMainFolder@@ will only be included if the
  1359. user's currently selected folder is the New-Mail or Inbox folder.
  1360.  
  1361. @@BeginIfNotMainFolder@@ - When this keyword is encountered, any lines that
  1362. follow, up to a closing @@EndIfNotMainFolder@@ will only be included in the
  1363. user's currently selected folder is any folder other than their New-Mail or
  1364. Inbox folder.
  1365.  
  1366. @@BeginIfSortStatus@@ - When this keyword is encountered, any lines that
  1367. follow, up to a closing @@EndIfSortStatus@@ will only be included if the
  1368. user's message sort order is to sort by status.
  1369.  
  1370. @@BeginIfSortFrom@@ - When this keyword is encountered, any lines that
  1371. follow, up to a closing @@EndIfSortFrom@@ will only be included if the
  1372. user's message sort order is to sort by the from field.
  1373.  
  1374. @@BeginIfSortSubject@@ - When this keyword is encountered, any lines that
  1375. follow, up to a closing @@EndIfSortSubject@@ will only be included if the
  1376. user's message sort order is to sort by the subject field.  (Sort by subject
  1377. is actually a sort by thread, which groups together messages with similar
  1378. subject lines.)
  1379.  
  1380. @@BeginIfSortDateTime@@ - When this keyword is encountered, any lines that
  1381. follow, up to a closing @@EndIfSortDateTime@@ will only be included if the
  1382. user's message sort order is to sort by date/time.
  1383.  
  1384. @@BeginIfAtTop@@ - When this keyword is encountered, any lines that follow,
  1385. up to a closing @@EndIfAtTop@@ will only be included if the message list is
  1386. at the top.  (e.g., if the top of the message list is the first message)
  1387.  
  1388. @@BeginIfNotAtTop@@ - When this keyword is encountered, any lines that
  1389. follow, up to a closing @@EndIfNotAtTop@@ will only be included if the
  1390. message list is not at the top.  (e.g., if the top of the message list is
  1391. not the first message)
  1392.  
  1393. @@BeginIfAtBottom@@ - When this keyword is encountered, any lines that
  1394. follow, up to a closing @@EndIfAtBottom@@ will only be included if the
  1395. message list is at the bottom.  (e.g., if the last message in the folder is
  1396. displayed on the current page)
  1397.  
  1398. @@BeginIfNotAtBottom@@ - When this keyword is encountered, any lines that
  1399. follow, up to a closing @@EndIfNotAtBottom@@ will only be included if the
  1400. message list is not at the bottom.  (e.g., if there are more messages in the
  1401. folder beyond the last message displayed on the current page)
  1402.  
  1403. @@BeginIfFoldersSupported@@ - When this keyword is encountered, any lines
  1404. that follow, up to a closing @@EndIfFoldersSupported@@ will only be included
  1405. if the current e-mail interface supports folders.  (Some e-mail interfaces,
  1406. most notably FFAPI, or POP3 pass-thru with folders disabled, do not support
  1407. folders.)
  1408.  
  1409. @@BeginRepeat@@ - When this keyword is encountered, any lines that follow,
  1410. up to a closing @@EndRepeat@@ will be included, and repeated for each
  1411. message that fits on the current page.
  1412.  
  1413. Special message list keywords available for each message (between
  1414. @@BeginRepeat@@ and @@EndRepeat@@ only):
  1415.  
  1416. @@IfUrgent@@ - The current line will only be included if the current message
  1417. has an urgent status.  (The @@ text will be removed.)
  1418.  
  1419. @@IfNotUrgent@@ - The current line will only be included if the current
  1420. message does not have urgent status.  (The @@ text will be removed.)
  1421.  
  1422. @@IfNew@@ - The current line will only be included if the current message
  1423. has a new status.  (The @@ text will be removed.)
  1424.  
  1425. @@IfNormal@@ - The current line will only be included if the current message
  1426. has been read.  (The @@ text will be removed.)
  1427.  
  1428. @@IfAttach@@ - The current line will only be included if the current message
  1429. has attachments.  (The @@ text will be removed.)
  1430.  
  1431. @@IfNotAttach@@ - The current line will only be included if the current
  1432. message does not have attachments.  (The @@ text will be removed.)
  1433.  
  1434. @@IfDraft@@ - The current line will only be included if the current message
  1435. has draft status.  (The @@ text will be removed.)
  1436.  
  1437. @@MessageID@@ - This specifies an extension to @@IndexURL@@ which, when
  1438. combined with @@IndexURL@@ is a URL that can be used to read this message.
  1439.  
  1440. @@UIDL@@ - This is a mail system dependent Unique ID to identify the current
  1441. message.  This is used in conjunction with a request to delete or file
  1442. multiple selected messages.
  1443.  
  1444. @@From@@ - From field from the current message.
  1445.  
  1446. @@Subject@@ - Subject field from the current message.
  1447.  
  1448. @@Date@@ - Date field for the current message.
  1449.  
  1450. @@Time@@ - Time field for the current message.
  1451.  
  1452. @@Size@@ - Size of the current message (e.g., 1K, 20K, 0.9K ... available
  1453. only in v3.11.01 and later)
  1454.  
  1455. Post variables:
  1456.  
  1457. Purge - SUBMIT BUTTON - This variable is set to indicate that the user
  1458. wishes to delete selected messages.  (The selected messages are specified
  1459. with the UIDL variable.)
  1460.  
  1461. MultipleFile - SUBMIT BUTTON - This variable is set to indicate that the
  1462. user wishes to file selected messages.  (The selected messages are specified
  1463. with the UIDL variable)
  1464.  
  1465. Reload - SUBMIT BUTTON - This variable is set to request that the message
  1466. list be refreshed.
  1467.  
  1468. SelectFolder - SUBMIT BUTTON - When this variable is set, the current folder
  1469. will be changed to the folder specified in the FolderName variable.
  1470.  
  1471. UIDL - This variable contains a list of unique message ids for carrying out
  1472. operations such as delete and file that can act against multiple messages.
  1473.  
  1474. FolderName - This variable contains a folder name, used in conjunction with
  1475. SelectFolder to change the current folder.
  1476.